-
Notifications
You must be signed in to change notification settings - Fork 2
Obi preview 1 #95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Obi preview 1 #95
Conversation
|
No spelling errors! 🎉 |
|
|
|
Re-rendered previews from the latest commit:
* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea. Updated at 2025-08-11 with changes from the latest commit f12bb05 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel that there is something important missing from this chapter, specifically the issue of LICENSE. The chapter title, contents and conclusion of the excellent tutorial video for creating a github repo all imply that we are starting an "open source" project. However, without adding license, the project is public but not open source. For a new github repo (even a public one) without a license, the default copyright laws apply, meaning that the author/creators retains all rights to their source code and no one may reproduce, distribute, or create derivative works. In order to be open source it must include a license which meets the definition of open source. The end of this chapter would be a good place to introduce this idea and maybe show how easy it is to add a license in github.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@carriewright11 is this one of the 3?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah but I took care of it - you can find what you need in the issues :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When running the renv::snapshot() command I was prompted with a dialogue:
It looks like you've called renv::snapshot() in a project that hasn't been activated yet.
How would you like to proceed?
1: Activate the project and use the project library.
2: Do not activate the project and use the current library paths.
3: Cancel and resolve the situation another way.
I wasn't sure of the correct response. It might be good to give some guidance to learners on this topic.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@carriewright11 is this another one of the 3?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, i see the linked issues now. Sorry
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no worries!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I struggled with the penultimate exercise for this chapter (7.5.1). I was working off a version of the code from previous chapters (which I think should have been up to date) but it didn't quite match the "before" code I was meant to update. So, I downloaded the suggested project files (section 7.4). However, these seemed to match the "before" expectation even less well. I think they are actually the "after" solution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I renamed each section to not say that is ok to use previous chapters - it looks like they change a bit each time and I called this the example projects instead of activity files. Would be great if you could check this again though
fixing broken links etc. from main
OTTR Check ResultsSummary
🎉 All checks passed!Last Updated: 2025-08-11-19:41:41 |
…sn't seem to occur before
|
@kweav It would be great to resolve these before the workshop if possible. I need to shift gears now. Could you take a look at the 3 remaining feedback points? I think it would be good to start a new PR for those. I made new issues for them |
|
@carriewright11 yes, I will take a look |
|
I can do the licensing one now actually @kweav |
thank you! |
resolves #101
Purpose/implementation Section
What changes are being implemented in this Pull Request?
What was your approach?
What GitHub issue does your pull request address?
Tell potential reviewers what kind of feedback you are soliciting.
New Content Checklist
New content/chapter is in an Rmd file with this kind of format and headers.
New content/chapter contains Learning Objectives and are in the correct format.
Bookdown successfully re-renders and any new content files have been added to the _bookdown.yml.
Spell check runs successfully in Github actions style-n-check).
Any newly necessary packages that are needed have been added to the Dockerfile and image.
Images are in the correct format for rendering.
Every new image has alt text and is in a Google Slide.
Each slide is described in the notes of the slide so learners relying on a screen reader can access the content. See https://lastcallmedia.com/blog/accessible-comics for more guidance on this.
The color palette choices of the slide are contrasted in a way that is friendly to those with color vision deficiencies.
You can check this using Color Oracle.